MapboxRouteLineOptions

class MapboxRouteLineOptions

Options for the configuration and appearance of the route line.

Parameters

resourceProvider

an instance of RouteLineResources

routeLayerProvider

an instance of RouteLayerProvider

originIcon

the drawable for representing the origin icon

destinationIcon

the drawable for representing the destination icon

routeLineBelowLayerId

determines the elevation of the route layers

vanishingRouteLine

an instance of the VanishingRouteLine

tolerance

the tolerance value used when configuring the underlying map source

displayRestrictedRoadSections

indicates if the route line will display restricted road sections with a dashed line

styleInactiveRouteLegsIndependently

enabling this feature will change the color of the route legs that aren't currently being navigated. See RouteLineColorResources to specify the color used.

displaySoftGradientForTraffic

determines if the color transition between traffic congestion changes should use a soft gradient appearance or abrupt color change. This is false by default.

softGradientTransition

influences the length of the color transition when the displaySoftGradientForTraffic parameter is true.

vanishingRouteLineUpdateIntervalNano

can be used to decrease the frequency of the vanishing route line updates improving the performance at the expense of visual appearance of the vanishing point on the line during navigation.

waypointLayerIconOffset

the list of offset values for waypoint icons

waypointLayerIconAnchor

the anchor value, the default is IconAnchor.CENTER

iconPitchAlignment

the pitch alignment value used for waypoint icons. The default is IconPitchAlignment.MAP

Types

Builder
Link copied to clipboard
class Builder
Responsible for instantiating an instance of MapboxRouteLineOptions

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
hashCode
Link copied to clipboard
open override fun hashCode(): Int
Returns a hash code value for the object.
toBuilder
Link copied to clipboard
fun toBuilder(context: Context): MapboxRouteLineOptions.Builder
toString
Link copied to clipboard
open override fun toString(): String
Returns a string representation of the object.

Properties

destinationIcon
Link copied to clipboard
val destinationIcon: Drawable
the drawable for representing the destination icon
displayRestrictedRoadSections
Link copied to clipboard
val displayRestrictedRoadSections: Boolean = false
indicates if the route line will display restricted road sections with a dashed line
displaySoftGradientForTraffic
Link copied to clipboard
val displaySoftGradientForTraffic: Boolean = false
determines if the color transition between traffic congestion changes should use a soft gradient appearance or abrupt color change.
iconPitchAlignment
Link copied to clipboard
val iconPitchAlignment: IconPitchAlignment
the pitch alignment value used for waypoint icons.
originIcon
Link copied to clipboard
val originIcon: Drawable
the drawable for representing the origin icon
resourceProvider
Link copied to clipboard
val resourceProvider: RouteLineResources
an instance of RouteLineResources
routeLineBelowLayerId
Link copied to clipboard
val routeLineBelowLayerId: String?
determines the elevation of the route layers
softGradientTransition
Link copied to clipboard
val softGradientTransition: Double
influences the length of the color transition when the displaySoftGradientForTraffic parameter is true.
styleInactiveRouteLegsIndependently
Link copied to clipboard
val styleInactiveRouteLegsIndependently: Boolean = false
enabling this feature will change the color of the route legs that aren't currently being navigated.
tolerance
Link copied to clipboard
val tolerance: Double
the tolerance value used when configuring the underlying map source
vanishingRouteLineUpdateIntervalNano
Link copied to clipboard
val vanishingRouteLineUpdateIntervalNano: Long
can be used to decrease the frequency of the vanishing route line updates improving the performance at the expense of visual appearance of the vanishing point on the line during navigation.
waypointLayerIconAnchor
Link copied to clipboard
val waypointLayerIconAnchor: IconAnchor
the anchor value, the default is IconAnchor.CENTER
waypointLayerIconOffset
Link copied to clipboard
val waypointLayerIconOffset: List<Double>
the list of offset values for waypoint icons